规划和实施集成变更
在更新您的集成之前,请先评估其对用户迁移和现有 Zap 的潜在影响,这一点至关重要。确保您的 API 和 Zapier 集成保持向后兼容性,以避免对用户造成中断。然而,我们承认某些变更有时是必要且不可避免的。在这种情况下,请考虑实施的最佳实践。
不同变更的影响(版本矩阵)
下表展示了不同变更对用户的影响。对于公共集成,这将影响推广以及是否可能进行迁移。请参考我们的最佳实践,以便为自身和用户简化升级过程。
列说明:
- Add:添加一个全新的组件
- Update:对现有组件进行变更
- Replace:删除/弃用现有组件并用新组件替换
- Delete/Deprecate:完全移除现有组件
矩阵关键:
- 破坏性变更:对集成进行的修改,会导致现有 Zap 与新版本不兼容
- 视实施而定:一种修改,视实施情况而定,可能导致现有 Zap 与新版本不兼容
- ✓:对集成进行的修改,会确保现有 Zap 与新版本兼容
- -:不适用
常见可能影响用户迁移能力的变更已在矩阵中链接的文档中详细说明。请查找您的变更,并注意推荐的最佳实践。
在您尝试在版本推广后进行 迁移 时,平台会验证几种变更场景,但请始终在实施变更之前就意识到这些变更的影响。
标记为 视实施而定 的变更场景如果没有链接的最佳实践,则可能因集成而异,因此无法提供通用的最佳实践;如果您需要针对特定变更场景的帮助,请联系 support。
集成变更 | Add | Update | Replace | Delete/Deprecate | 平台验证? |
---|---|---|---|---|---|
身份验证变更 | |||||
身份验证方案 | 破坏性变更 | - | 破坏性变更 | - | |
身份验证字段 - 必填 | 破坏性变更 | 视实施而定 | - | - | |
身份验证字段 - 可选 | - | - | |||
身份验证字段键 | - | 破坏性变更 | - | - | - |
身份验证 - 令牌请求 | - | - | - | - | |
身份验证 - 测试函数 | - | - | - | ||
触发器/操作变更 | |||||
触发器/操作 - 元信息(例如:标签、描述) | - | - | - | ||
触发器/操作 - 键 | - | 破坏性变更 | 破坏性变更 | - | |
触发器/操作 - 输入字段 - 必填 | 视实施而定 | 视实施而定 | 视实施而定 | - | |
触发器/操作 - 输入字段 - 可选 | - | ||||
触发器/操作 - 输入字段 - 键 | - | 破坏性变更 | 破坏性变更 | - | - |
触发器/操作 - 输入字段 - 字段类型 | - | 视实施而定 | 视实施而定 | - | - |
触发器/操作 - 输出数据 - 键 | 破坏性变更 | 破坏性变更 | 破坏性变更 | - | |
触发器/操作 - 输出数据 - 响应结构 | - | 破坏性变更 | 破坏性变更 | - | - |
触发器/操作 - 执行函数 | - | 视实施而定 | 视实施而定 | - | - |
触发器类型 - 从轮询类型变为钩子类型 | - | 破坏性变更 | - | - | |
触发器(轮询) - 执行函数 | - | 视实施而定 | 视实施而定 | - | - |
触发器(钩子) - 执行列表 | - | 视实施而定 | 视实施而定 | - | - |
触发器(钩子) - 执行订阅 | - | - | - | ||
触发器(钩子) - 执行取消订阅 | - | - | - | ||
其他变更 | |||||
中间件 | 视实施而定 | 视实施而定 | 视实施而定 | 视实施而定 | - |
合作伙伴的 API(整体) | - | 视实施而定 | 视实施而定 | 视实施而定 | - |
产品功能 | - | - | - | - | |
品牌重塑 - (例如:徽标、应用名称) | - | - | - | - | |
从 UI 导出到 CLI | - | 视实施而定 | - | - | |
从 CLI 导出到 UI | - | 视实施而定 | - | - | - |
编辑旧版 Web Builder 集成 | - | 视实施而定 | 视实施而定 | - | - |
如果您的变更未列出,请确保检查它是否会更改键、要求用户提供 新 信息,或撤消某些功能。